From 36673f2775e698c0cea58b25320cb037a28e1ec1 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Thu, 20 Sep 2012 22:49:55 +0200 Subject: [PATCH] Improve documentation of maintenance scripts. Change-Id: Id86d06d3c22a69f7e378bf6e75b5c78ef8b47c51 --- maintenance/language/langmemusage.php | 11 ++++++--- maintenance/locking/LockServerDaemon.php | 2 ++ maintenance/oracle/alterSharedConstraints.php | 23 ++++++++++--------- maintenance/storage/checkStorage.php | 2 ++ maintenance/storage/compressOld.php | 5 ++++ maintenance/storage/dumpRev.php | 9 ++++++++ maintenance/storage/fixBug20757.php | 5 ++++ maintenance/storage/orphanStats.php | 11 +++++++-- maintenance/storage/recompressTracked.php | 6 +++++ maintenance/storage/resolveStubs.php | 4 ++-- maintenance/storage/testCompression.php | 5 ++-- 11 files changed, 63 insertions(+), 20 deletions(-) diff --git a/maintenance/language/langmemusage.php b/maintenance/language/langmemusage.php index 2323638e26..ad29efb2f5 100644 --- a/maintenance/language/langmemusage.php +++ b/maintenance/language/langmemusage.php @@ -1,7 +1,6 @@ output( "Base memory usage: $memstart\n" ); - + foreach ( $langtool->getLanguages() as $langcode ) { Language::factory( $langcode ); $memstep = memory_get_usage(); diff --git a/maintenance/locking/LockServerDaemon.php b/maintenance/locking/LockServerDaemon.php index 689c93092d..f45525c2f0 100644 --- a/maintenance/locking/LockServerDaemon.php +++ b/maintenance/locking/LockServerDaemon.php @@ -39,6 +39,8 @@ LockServerDaemon::init( /** * Simple lock server daemon that accepts lock/unlock requests + * + * @ingroup LockManager Maintenance */ class LockServerDaemon { /** @var resource */ diff --git a/maintenance/oracle/alterSharedConstraints.php b/maintenance/oracle/alterSharedConstraints.php index e222314dd3..a46c5e1f4c 100644 --- a/maintenance/oracle/alterSharedConstraints.php +++ b/maintenance/oracle/alterSharedConstraints.php @@ -15,13 +15,14 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html * + * @file * @ingroup Maintenance */ /** * When using shared tables that are referenced by foreign keys on local * tables you have to change the constraints on local tables. - * + * * The shared tables have to have GRANT REFERENCE on shared tables to local schema * i.e.: GRANT REFERENCES (user_id) ON mwuser TO hubclient; */ @@ -40,12 +41,12 @@ class AlterSharedConstraints extends Maintenance { public function execute() { global $wgSharedDB, $wgSharedTables, $wgSharedPrefix, $wgDBprefix; - + if ( $wgSharedDB == null ) { $this->output( "Database sharing is not enabled\n" ); return; } - + $dbw = wfGetDB( DB_MASTER ); foreach ( $wgSharedTables as $table ) { $stable = $dbw->tableNameInternal($table); @@ -54,7 +55,7 @@ class AlterSharedConstraints extends Maintenance { } else { $ltable = "{$wgDBprefix}{$stable}" ; } - + $result = $dbw->query( "SELECT uc.constraint_name, uc.table_name, ucc.column_name, uccpk.table_name pk_table_name, uccpk.column_name pk_column_name, uc.delete_rule, uc.deferrable, uc.deferred FROM user_constraints uc, user_cons_columns ucc, user_cons_columns uccpk WHERE uc.constraint_type = 'R' @@ -62,9 +63,9 @@ class AlterSharedConstraints extends Maintenance { AND uccpk.constraint_name = uc.r_constraint_name AND uccpk.table_name = '$ltable'" ); while (($row = $result->fetchRow()) !== false) { - + $this->output( "Altering {$row['constraint_name']} ..."); - + try { $dbw->query( "ALTER TABLE {$row['table_name']} DROP CONSTRAINT {$wgDBprefix}{$row['constraint_name']}" ); } catch (DBQueryError $exdb) { @@ -72,13 +73,13 @@ class AlterSharedConstraints extends Maintenance { throw $exdb; } } - + $deleteRule = $row['delete_rule'] == 'NO ACTION' ? '' : "ON DELETE {$row['delete_rule']}"; - $dbw->query( "ALTER TABLE {$row['table_name']} ADD CONSTRAINT {$wgDBprefix}{$row['constraint_name']} - FOREIGN KEY ({$row['column_name']}) - REFERENCES {$wgSharedDB}.$stable({$row['pk_column_name']}) + $dbw->query( "ALTER TABLE {$row['table_name']} ADD CONSTRAINT {$wgDBprefix}{$row['constraint_name']} + FOREIGN KEY ({$row['column_name']}) + REFERENCES {$wgSharedDB}.$stable({$row['pk_column_name']}) {$deleteRule} {$row['deferrable']} INITIALLY {$row['deferred']}" ); - + $this->output( "DONE\n" ); } } diff --git a/maintenance/storage/checkStorage.php b/maintenance/storage/checkStorage.php index 6c669bfa07..5797a6c744 100644 --- a/maintenance/storage/checkStorage.php +++ b/maintenance/storage/checkStorage.php @@ -38,6 +38,8 @@ if ( !defined( 'MEDIAWIKI' ) ) { // ---------------------------------------------------------------------------------- /** + * Maintenance script to do various checks on external storage. + * * @ingroup Maintenance ExternalStorage */ class CheckStorage { diff --git a/maintenance/storage/compressOld.php b/maintenance/storage/compressOld.php index 4594db716c..951ab1a506 100644 --- a/maintenance/storage/compressOld.php +++ b/maintenance/storage/compressOld.php @@ -43,6 +43,11 @@ require_once( __DIR__ . '/../Maintenance.php' ); +/** + * Maintenance script that compress the text of a wiki. + * + * @ingroup Maintenance ExternalStorage + */ class CompressOld extends Maintenance { /** * @todo document diff --git a/maintenance/storage/dumpRev.php b/maintenance/storage/dumpRev.php index 6020f22e19..39f08f9de7 100644 --- a/maintenance/storage/dumpRev.php +++ b/maintenance/storage/dumpRev.php @@ -1,5 +1,7 @@ execute(); +/** + * Maintenance script that moves blobs indexed by trackBlobs.php to a specified + * list of destination clusters, and recompresses them in the process. + * + * @ingroup Maintenance ExternalStorage + */ class RecompressTracked { var $destClusters; var $batchSize = 1000; diff --git a/maintenance/storage/resolveStubs.php b/maintenance/storage/resolveStubs.php index 7e288e136a..0f5cd2b4f0 100644 --- a/maintenance/storage/resolveStubs.php +++ b/maintenance/storage/resolveStubs.php @@ -1,7 +1,7 @@